Class DeviceDescriptorImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.DeviceDescriptorImpl
All Implemented Interfaces:
IPCObject, DeviceDescriptor

public class DeviceDescriptorImpl extends IPCObjectImpl implements DeviceDescriptor
Information provided by the PKI file:

    \class DeviceDescriptor
    
    \brief Descriptor for a device.
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getType

      public DeviceType getType()
      Information provided by the PKI file:
      
          \brief Return device type
          
          \return DeviceType start with 0 and add 1 for subsequent type
          eRouter = 0,
          eSwitch,
          eCloud,
          eBridge,
          eHub,
          eRepeater,
          eCoAxialSplitter,
          eAccessPoint,
          ePc,
          eServer,
          ePrinter,
          eWirelessRouter,
          eIpPhone,
          eDslModem,
          eCableModem,
          eRemoteNetwork,
          eMultiLayerSwitch,
          eLaptop,
          eTabletPC,
          ePda,
          eWirelessEndDevice,
          eWiredEndDevice,
          eTV,
          eHomeVoip,
          eAnalogPhone,
          eMultiUser,
          eASA,
          eIoE,
          eHomeGateway,
          eCellTower,
          eCentralOfficeServer,
          eCiscoAccessPoint,
          eEmbeddedCiscoAccessPoint,
          eSniffer,
          eMCU,
          eSBC,
          eThing,
          eMCUComponent,
          eEmbeddedServer,
          eWirelessLanController,
          eCluster,
          eGeoIcon
          
              
      Specified by:
      getType in interface DeviceDescriptor
      Returns:
      DeviceType Returns a DeviceType
    • getModel

      public String getModel()
      Information provided by the PKI file:
      
          \brief Get device model
          
          \return string, device model in string format
          
              
      Specified by:
      getModel in interface DeviceDescriptor
      Returns:
      String Returns a String
    • addSupportedModuleType

      public void addSupportedModuleType(ModuleType type)
      Information provided by the PKI file:
      
          \brief Add supported module type to device descriptor
          
          \param type, module type ModuleType, start with 0 and add 1 to subsequent module type
          eLineCard=0,
          eNetworkModule,
          eInterfaceCard,
          ePtRouterModule,
          ePtSwitchModule,
          ePtCloudModule,
          ePtRepeaterModule,
          ePtHostModule,
          ePtModemModule,
          ePtLaptopModule,
          ePtTVModule,
          eIpPhonePowerAdapter,
          ePtTabletPCModule,
          ePtPdaModule,
          ePtWirelessEndDeviceModule,
          ePtWiredEndDeviceModule,
          eTrs35,
          eUsb,
          eNonRemovableModule,
          eASAModule,
          eASAPowerAdapter,
          ePtCellTowerModule,
          ePtIoeModule,
          ePtIoeNetworkModule,
          ePtIoeAnalogModule,
          ePtIoeDigitalModule,
          ePtIoeCustomIOModule,
          ePtIoePowerAdapter,
          ePtIoeMcuComponentPowerAdapter,
          ePtRouterPowerAdapter,
          eSfpModule,
          eAccessPointPowerAdaptor,
          eNonRemovableInterfaceCard,
          eCustomModuleType = 2000
          
              
      Specified by:
      addSupportedModuleType in interface DeviceDescriptor
      Parameters:
      type - Takes in a parameter of type
    • removeSupportedModuleType

      public void removeSupportedModuleType(ModuleType type)
      Information provided by the PKI file:
      
          \brief Remove supported module type to device descriptor
          
          \param type, module type ModuleType, same type as param for addSupportedModuleType().
          
              
      Specified by:
      removeSupportedModuleType in interface DeviceDescriptor
      Parameters:
      type - Takes in a parameter of type
    • isModuleTypeSupported

      public boolean isModuleTypeSupported(ModuleType type)
      Information provided by the PKI file:
      
          \brief Check if module type is supported
          
          \param type, ModuleType
          
          \param type, module type ModuleType, start with 0 and add 1 to subsequent module type
          eLineCard=0,
          eNetworkModule,
          eInterfaceCard,
          ePtRouterModule,
          ePtSwitchModule,
          ePtCloudModule,
          ePtRepeaterModule,
          ePtHostModule,
          ePtModemModule,
          ePtLaptopModule,
          ePtTVModule,
          eIpPhonePowerAdapter,
          ePtTabletPCModule,
          ePtPdaModule,
          ePtWirelessEndDeviceModule,
          ePtWiredEndDeviceModule,
          eTrs35,
          eUsb,
          eNonRemovableModule,
          eASAModule,
          eASAPowerAdapter,
          ePtCellTowerModule,
          ePtIoeModule,
          ePtIoeNetworkModule,
          ePtIoeAnalogModule,
          ePtIoeDigitalModule,
          ePtIoeCustomIOModule,
          ePtIoePowerAdapter,
          ePtIoeMcuComponentPowerAdapter,
          ePtRouterPowerAdapter,
          eSfpModule,
          eAccessPointPowerAdaptor,
          eNonRemovableInterfaceCard,
          eCustomModuleType = 2000
          
          \return bool, true if the module type is supported and false if not
          
              
      Specified by:
      isModuleTypeSupported in interface DeviceDescriptor
      Parameters:
      type - Takes in a parameter of type
      Returns:
      boolean Returns a boolean
    • getSupportedModuleTypeCount

      public int getSupportedModuleTypeCount()
      Information provided by the PKI file:
      
          \brief Get the number of module type
          
          \return int, number of module type
          
              
      Specified by:
      getSupportedModuleTypeCount in interface DeviceDescriptor
      Returns:
      int Returns a int
    • getSupportedModuleTypeAt

      public ModuleType getSupportedModuleTypeAt(int index)
      Information provided by the PKI file:
      
          \brief Get the supported module type at a specified index
          
          \param index, the specified index
          
          \return ModuleType, see different types documented in addSupportedModuleType() function
          
              
      Specified by:
      getSupportedModuleTypeAt in interface DeviceDescriptor
      Parameters:
      index - Takes in a parameter of index
      Returns:
      ModuleType Returns a ModuleType
    • getRootModule

      public ModuleDescriptor getRootModule()
      Information provided by the PKI file:
      
          \brief Get the root module descriptor
          
          \return ModuleDescriptor, root module descriptor
          
              
      Specified by:
      getRootModule in interface DeviceDescriptor
      Returns:
      ModuleDescriptor Returns a ModuleDescriptor
    • isModelSupported

      public boolean isModelSupported()
      Information provided by the PKI file:
      
          \brief Check if the descriptor is model supported
          
          \return bool, true if model supported and false if not
          
              
      Specified by:
      isModelSupported in interface DeviceDescriptor
      Returns:
      boolean Returns a boolean
    • getSpecifiedModelCount

      public int getSpecifiedModelCount()
      Information provided by the PKI file:
      
          \brief Get specified model count
          
          \return int, the number of specified model
          
              
      Specified by:
      getSpecifiedModelCount in interface DeviceDescriptor
      Returns:
      int Returns a int
    • getSpecifiedModelAt

      public String getSpecifiedModelAt(int index)
      Information provided by the PKI file:
      
          \brief Get specified model at a specified index
          
          \param index, specified index
          
          \return string, the specified model name in string format
          
              
      Specified by:
      getSpecifiedModelAt in interface DeviceDescriptor
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • isExistSpecifiedModel

      public boolean isExistSpecifiedModel(String model)
      Information provided by the PKI file:
      
          \brief Check if the model exist
          
          \param model, specified model
          
          \return bool, true if the model exist and false if it does not
          
              
      Specified by:
      isExistSpecifiedModel in interface DeviceDescriptor
      Parameters:
      model - Takes in a parameter of model
      Returns:
      boolean Returns a boolean
    • addSpecifiedModel

      public void addSpecifiedModel(String model)
      Information provided by the PKI file:
      
          \brief Add module model to support
          
          \param model, specified model
          
              
      Specified by:
      addSpecifiedModel in interface DeviceDescriptor
      Parameters:
      model - Takes in a parameter of model
    • removeSpecifiedModel

      public void removeSpecifiedModel(String model)
      Information provided by the PKI file:
      
          \brief Remove model model to support
          
          \param model, specified model
          
              
      Specified by:
      removeSpecifiedModel in interface DeviceDescriptor
      Parameters:
      model - Takes in a parameter of model
    • setModelSupportedFlag

      public void setModelSupportedFlag(boolean isSupported)
      Information provided by the PKI file:
      
          \brief Set supported flag to the device descriptor
          
          \param isSupported, true if supported and false if not
          
          \return none
          
              
      Specified by:
      setModelSupportedFlag in interface DeviceDescriptor
      Parameters:
      isSupported - Takes in a parameter of isSupported
    • addRequiredScriptModule

      public void addRequiredScriptModule(String smId)
      Information provided by the PKI file:
      
          \brief Add required script module
          
          \param smId, script module id
          
          \return none
          
              
      Specified by:
      addRequiredScriptModule in interface DeviceDescriptor
      Parameters:
      smId - Takes in a parameter of smId
    • removeRequiredScriptModule

      public void removeRequiredScriptModule(String smId)
      Information provided by the PKI file:
      
          \brief Removed required script module
          
          \param smId, script module id
          
          \return none
          
              
      Specified by:
      removeRequiredScriptModule in interface DeviceDescriptor
      Parameters:
      smId - Takes in a parameter of smId
    • getRequiredScriptModuleCount

      public int getRequiredScriptModuleCount()
      Information provided by the PKI file:
      
          \brief Get the number of required script module
          
          \return int, number of required script module
          
              
      Specified by:
      getRequiredScriptModuleCount in interface DeviceDescriptor
      Returns:
      int Returns a int
    • getRequiredScriptModuleAt

      public String getRequiredScriptModuleAt(int index)
      Information provided by the PKI file:
      
          \brief Get the name of the required script module at a specified index
          
          \param index, specified index
          
          \return string, script module name
          
              
      Specified by:
      getRequiredScriptModuleAt in interface DeviceDescriptor
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String